Rainbow Android SDK/com.ale.rainbowsdk/FileStorage

FileStorage

interface FileStorage

Types

Companion

object Companion

IFileStorageListener

interface IFileStorageListener

Interface defining callbacks for handling events related to FileStorage within the SDK.

Properties

externalStorageName

abstract val externalStorageName: String?

Get the current connected user external storage name if any.

externalStorageUrl

abstract val externalStorageUrl: String?

Get the current connected user external storage URL if any.

Functions

addViewerToFileDescriptor

abstract fun addViewerToFileDescriptor(fileDescriptor: RainbowFileDescriptor, viewer: RainbowFileViewer, listener: RainbowListener<RainbowFileDescriptor, FileRepository.ViewerError>? = null)

Adds a RainbowFileViewer to a RainbowFileDescriptor The specified viewer will have access to the RainbowFileDescriptor, they will be able to download and view the file.

addViewerToFileDescriptors

abstract fun addViewerToFileDescriptors(fileDescriptors: List<RainbowFileDescriptor>, viewer: RainbowFileViewer, listener: RainbowListener<List<RainbowFileDescriptor>, Map<Int, List<RainbowFileDescriptor>>>? = null)

Adds a RainbowFileViewer to as list of RainbowFileDescriptor

cancelDownload

abstract fun cancelDownload(fileDescriptor: RainbowFileDescriptor): Boolean

Cancel the download started on the RainbowFileDescriptor. If there is a downloaded file, partial or complete, it is deleted.

cancelUpload

abstract fun cancelUpload(fileDescriptor: RainbowFileDescriptor)

Cancel the upload started on the RainbowFileDescriptor.

copyFileDescriptorsToPersonalStorage

abstract fun copyFileDescriptorsToPersonalStorage(fileDescriptors: List<RainbowFileDescriptor>, hidePurpose: Boolean = false, listener: RainbowListener<List<RainbowFileDescriptor>, Map<Int, List<RainbowFileDescriptor>>>? = null)

As a viewer of multiple RainbowFileDescriptors, upload a copy in the user personal storage

copyFileDescriptorToPersonalStorage

abstract fun copyFileDescriptorToPersonalStorage(fileDescriptor: RainbowFileDescriptor, hidePurpose: Boolean = false, listener: RainbowListener<RainbowFileDescriptor, FileRepository.CopyFileDescriptorError>? = null)

As a viewer of the RainbowFileDescriptor, upload a copy in the user personal storage

createExternalLinkForRoom

abstract fun createExternalLinkForRoom(roomId: String, listener: RainbowListener<String, Unit>)

Create the external storage URL for accessing shared files within a room. Only Bubble owner can do it.

deleteAllDownloadedFiles

abstract fun deleteAllDownloadedFiles()

Deletes all previously downloaded files on the device

deleteAllFileDescriptors

abstract fun deleteAllFileDescriptors(listener: RainbowListener<Unit, FileRepository.DeleteFileDescriptorError>? = null)

Deletes all RainbowFileDescriptor owned by the user

deleteFileDescriptor

abstract fun deleteFileDescriptor(fileDescriptor: RainbowFileDescriptor, listener: RainbowListener<Unit, FileRepository.DeleteFileDescriptorError>? = null)

Deletes the RainbowFileDescriptor from the server

deleteFileDescriptors

abstract fun deleteFileDescriptors(fileDescriptors: List<RainbowFileDescriptor>, listener: RainbowListener<Unit, Unit>? = null)

Deletes a list of RainbowFileDescriptor from the server

deleteFileDescriptorsViewer

abstract fun deleteFileDescriptorsViewer(fileDescriptors: List<RainbowFileDescriptor>, viewerIdToDelete: String, listener: RainbowListener<Unit, FileRepository.ViewerError>?)

Deletes a given viewer from a list of RainbowFileDescriptor

deleteFileDescriptorViewer

abstract fun deleteFileDescriptorViewer(fileDescriptor: RainbowFileDescriptor, viewerIdToDelete: String, deleteFileOnLastViewer: Boolean = false, listener: RainbowListener<Unit, FileRepository.ViewerError>? = null)

Deletes a given viewer from a RainbowFileDescriptor The user must be a current viewer of the RainbowFileDescriptor, once deleted, they will no longer have access to it

downloadFile

abstract fun downloadFile(fileDescriptor: RainbowFileDescriptor, listener: RainbowListener<RainbowFileDescriptor, Unit>? = null)

Download the file from the server. This method uses the Android DownloadManager

fetchFileDescriptorById

abstract fun fetchFileDescriptorById(fileDescriptorId: String?, listener: RainbowListener<RainbowFileDescriptor, FileRepository.FetchFileDescriptorError>? = null): RainbowFileDescriptor?

Returns a RainbowFileDescriptor and fetch last data from the server

fetchFileInBubble

abstract fun fetchFileInBubble(room: Room, limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of RainbowFileDescriptor received in a bubble conversation This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of RainbowFileDescriptor received in this bubble, no results are returned.

fetchFileInConversation

abstract fun fetchFileInConversation(conversation: IRainbowConversation, limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of RainbowFileDescriptor in a conversation This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of RainbowFileDescriptor in this conversation, no results are returned.

fetchFileReceived

abstract fun fetchFileReceived(limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of received RainbowFileDescriptor This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of received RainbowFileDescriptor, no results are returned. This method does not filters results.

fetchFileReceivedInBubble

abstract fun fetchFileReceivedInBubble(room: Room, limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

fetchFileReceivedInConversation

abstract fun fetchFileReceivedInConversation(conversation: IRainbowConversation, limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of RainbowFileDescriptor received in a conversation This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of RainbowFileDescriptor received in this conversation, no results are returned.

fetchFileSent

abstract fun fetchFileSent(limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of sent RainbowFileDescriptor This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of sent RainbowFileDescriptor, no results are returned. This method does not filters results.

fetchFileSentInBubble

abstract fun fetchFileSentInBubble(room: Room, limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of RainbowFileDescriptor in a bubble conversation This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of RainbowFileDescriptor in this bubble, no results are returned.

fetchFileSentInConversation

abstract fun fetchFileSentInConversation(conversation: IRainbowConversation, limit: Int, offset: Int, listener: RainbowListener<List<RainbowFileDescriptor>, Unit>? = null)

Fetches a list of RainbowFileDescriptor sent in a conversation This method accept a limit and an offset parameters for pagination, when limit is set to 0, the API returns a maximum of 100 results. If offset is greater that the limit of RainbowFileDescriptor sent in this conversation, no results are returned.

fileOwnershipChange

abstract fun fileOwnershipChange(fileDescriptor: RainbowFileDescriptor, ownerId: String, listener: RainbowListener<RainbowFileDescriptor, FileRepository.ChangeOwnershipError>? = null)

Drops the ownership to another Rainbow user of the same company The user must be in the same company and allowed by administrator

getCurrentUploadsByIdentifier

abstract fun getCurrentUploadsByIdentifier(identifier: String): List<RainbowFileDescriptor>

Retrieve the current uploads if there are any

getExternalLinkForRoom

abstract fun getExternalLinkForRoom(roomId: String, listener: RainbowListener<String, Unit>)

Get the external storage URL for accessing shared files within a room.

getExternalLoginUrl

abstract fun getExternalLoginUrl(callback: String, listener: RainbowListener<String, Unit>)

Retrieves the external storage login URL associated to the connected user.

getFileDescriptorById

abstract fun getFileDescriptorById(fileDescriptorId: String): RainbowFileDescriptor?

Returns a RainbowFileDescriptor if found in local list

getFileDownloaded

abstract fun getFileDownloaded(fileDescriptor: RainbowFileDescriptor): File?

Retrieves the downloaded file associated to the RainbowFileDescriptor from the device

getUserQuotaConsumption

abstract fun getUserQuotaConsumption(listener: RainbowListener<Consumption, Unit>? = null): Consumption?

Retrieves the current file storage consumption and quota associated to the connected user.

isDownloaded

abstract fun isDownloaded(fileDescriptor: RainbowFileDescriptor): Boolean

Checks if the file has already been downloaded to the device

registerListener

abstract fun registerListener(listener: FileStorage.IFileStorageListener)

unregisterListener

abstract fun unregisterListener(listener: FileStorage.IFileStorageListener)

Unregister to the listener with following triggers: onMaxQuotaReached

uploadFiles

abstract fun uploadFiles(fileDescriptors: List<RainbowFileDescriptor>, viewer: RainbowFileViewer? = null, identifier: String? = null, resolution: Int? = HIGH_RESOLUTION, listener: RainbowListener<List<RainbowFileDescriptor>, Map<Int, List<RainbowFileDescriptor>>>? = null)

Upload a list of files with a specific RainbowFileViewer

uploadFileToBubble

abstract fun uploadFileToBubble(room: Room, uriFile: Uri, listener: RainbowListener<RainbowFileDescriptor, Unit>? = null)

Uploads a file to a bubble A new RainbowFileDescriptor will be create with the user as the owner, the bubble will be a viewer for this RainbowFileDescriptor.

uploadFileToChannel

abstract fun uploadFileToChannel(channel: Channel, uriFile: Uri, listener: RainbowListener<RainbowFileDescriptor, Unit>? = null)

Uploads a file to a channel A new RainbowFileDescriptor will be create with the user as the owner, the channel will be a viewer for this RainbowFileDescriptor.

uploadFileToConversation

abstract fun uploadFileToConversation(conversation: IRainbowConversation, uriFile: Uri, listener: RainbowListener<RainbowFileDescriptor, Unit>? = null)

Uploads a file to a conversation A new RainbowFileDescriptor will be create with the user as the owner, the IRainbowConversation will be a viewer for this RainbowFileDescriptor whether it's a contact or a bubble.

uploadFileToPersonalStorage

abstract fun uploadFileToPersonalStorage(uriFile: Uri, listener: RainbowListener<RainbowFileDescriptor, Unit>? = null)

Uploads a file to the user personal storage